Eclipse Platform
Pre-release 3.0

org.eclipse.team.ui.synchronize
Interface ISynchronizeParticipantDescriptor


public interface ISynchronizeParticipantDescriptor

A participant descriptor contains the content of the synchronizeParticipants extension section for for a registered participant type in the declaring plug-in's manifest (plugin.xml) file.

This interface is not intended to be implemented by clients.

Since:
3.0
See Also:
ISynchronizeManager.getParticipantDescriptor(String)

Method Summary
 String getDescription()
          Returns a string describing this participant type.
 String getId()
          Returns the unique id that identifies this participant type.
 ImageDescriptor getImageDescriptor()
          Returns the image descriptor for this participant type.
 boolean isStatic()
          Returns true if the participant is static and false otherwise.
 

Method Detail

getDescription

public String getDescription()
Returns a string describing this participant type.

Returns:
a string describing this participant type.

getId

public String getId()
Returns the unique id that identifies this participant type.

Returns:
the unique id that identifies this participant type.

getImageDescriptor

public ImageDescriptor getImageDescriptor()
Returns the image descriptor for this participant type.

Returns:
the image descriptor for this participant type.

isStatic

public boolean isStatic()
Returns true if the participant is static and false otherwise. Static participants are created automatically by the synchronize manager at startup whereas not static participants are created by client code and registered with the manager.

Returns:
true if the participant is static and false otherwise

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.